<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /* <a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009 Regents of the University of Colorado.  <a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved. <a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License"); <a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License. <a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at <a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0 <a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software <a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS, <a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and <a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.uutuc.factory;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.IOException;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.net.URL;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.uima.Constants;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.uima.UIMAException;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.uima.UIMAFramework;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.collection.CollectionReader;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.collection.CollectionReaderDescription;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.collection.impl.CollectionReaderDescription_impl;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.resource.ResourceCreationSpecifier;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.resource.ResourceInitializationException;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.resource.ResourceSpecifier;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.resource.metadata.Capability;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.resource.metadata.ConfigurationParameter;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.uima.resource.metadata.TypePriorities;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.uima.resource.metadata.TypeSystemDescription;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.uima.resource.metadata.impl.Import_impl;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.uutuc.factory.ConfigurationParameterFactory.ConfigurationData;<a name="line.37"></a>
<FONT color="green">038</FONT>    <a name="line.38"></a>
<FONT color="green">039</FONT>    /**<a name="line.39"></a>
<FONT color="green">040</FONT>     * @author Steven Bethard, Philip Ogren<a name="line.40"></a>
<FONT color="green">041</FONT>     */<a name="line.41"></a>
<FONT color="green">042</FONT>    public class CollectionReaderFactory {<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>            /**<a name="line.44"></a>
<FONT color="green">045</FONT>             * Create a CollectionReader from an XML descriptor file and a set of<a name="line.45"></a>
<FONT color="green">046</FONT>             * configuration parameters.<a name="line.46"></a>
<FONT color="green">047</FONT>             * <a name="line.47"></a>
<FONT color="green">048</FONT>             * @param descriptorPath<a name="line.48"></a>
<FONT color="green">049</FONT>             *            The path to the XML descriptor file.<a name="line.49"></a>
<FONT color="green">050</FONT>             * @param configurationData<a name="line.50"></a>
<FONT color="green">051</FONT>             *            Any additional configuration parameters to be set. These<a name="line.51"></a>
<FONT color="green">052</FONT>             *            should be supplied as (name, value) pairs, so there should<a name="line.52"></a>
<FONT color="green">053</FONT>             *            always be an even number of parameters.<a name="line.53"></a>
<FONT color="green">054</FONT>             * @return The CollectionReader created from the XML descriptor and the<a name="line.54"></a>
<FONT color="green">055</FONT>             *         configuration parameters.<a name="line.55"></a>
<FONT color="green">056</FONT>             * @throws UIMAException<a name="line.56"></a>
<FONT color="green">057</FONT>             * @throws IOException<a name="line.57"></a>
<FONT color="green">058</FONT>             */<a name="line.58"></a>
<FONT color="green">059</FONT>            public static CollectionReader createCollectionReaderFromPath(String descriptorPath, Object... configurationData)<a name="line.59"></a>
<FONT color="green">060</FONT>                            throws UIMAException, IOException {<a name="line.60"></a>
<FONT color="green">061</FONT>                    ResourceCreationSpecifier specifier = ResourceCreationSpecifierFactory.createResourceCreationSpecifier(<a name="line.61"></a>
<FONT color="green">062</FONT>                                    descriptorPath, configurationData);<a name="line.62"></a>
<FONT color="green">063</FONT>                    return UIMAFramework.produceCollectionReader(specifier);<a name="line.63"></a>
<FONT color="green">064</FONT>            }<a name="line.64"></a>
<FONT color="green">065</FONT>    <a name="line.65"></a>
<FONT color="green">066</FONT>            /**<a name="line.66"></a>
<FONT color="green">067</FONT>             * Get a CollectionReader from the name (Java-style, dotted) of an XML<a name="line.67"></a>
<FONT color="green">068</FONT>             * descriptor file, and a set of configuration parameters.<a name="line.68"></a>
<FONT color="green">069</FONT>             * <a name="line.69"></a>
<FONT color="green">070</FONT>             * @param descriptorName<a name="line.70"></a>
<FONT color="green">071</FONT>             *            The fully qualified, Java-style, dotted name of the XML<a name="line.71"></a>
<FONT color="green">072</FONT>             *            descriptor file.<a name="line.72"></a>
<FONT color="green">073</FONT>             * @param configurationData<a name="line.73"></a>
<FONT color="green">074</FONT>             *            Any additional configuration parameters to be set. These<a name="line.74"></a>
<FONT color="green">075</FONT>             *            should be supplied as (name, value) pairs, so there should<a name="line.75"></a>
<FONT color="green">076</FONT>             *            always be an even number of parameters.<a name="line.76"></a>
<FONT color="green">077</FONT>             * @return The AnalysisEngine created from the XML descriptor and the<a name="line.77"></a>
<FONT color="green">078</FONT>             *         configuration parameters.<a name="line.78"></a>
<FONT color="green">079</FONT>             * @throws UIMAException<a name="line.79"></a>
<FONT color="green">080</FONT>             * @throws IOException<a name="line.80"></a>
<FONT color="green">081</FONT>             */<a name="line.81"></a>
<FONT color="green">082</FONT>    <a name="line.82"></a>
<FONT color="green">083</FONT>            public static CollectionReader createCollectionReader(String descriptorName, Object... configurationData)<a name="line.83"></a>
<FONT color="green">084</FONT>                            throws UIMAException, IOException {<a name="line.84"></a>
<FONT color="green">085</FONT>                    Import_impl imp = new Import_impl();<a name="line.85"></a>
<FONT color="green">086</FONT>                    imp.setName(descriptorName);<a name="line.86"></a>
<FONT color="green">087</FONT>                    URL url = imp.findAbsoluteUrl(UIMAFramework.newDefaultResourceManager());<a name="line.87"></a>
<FONT color="green">088</FONT>                    ResourceSpecifier specifier = ResourceCreationSpecifierFactory.createResourceCreationSpecifier(url, configurationData);<a name="line.88"></a>
<FONT color="green">089</FONT>                    return UIMAFramework.produceCollectionReader(specifier);<a name="line.89"></a>
<FONT color="green">090</FONT>            }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>            <a name="line.92"></a>
<FONT color="green">093</FONT>            /**<a name="line.93"></a>
<FONT color="green">094</FONT>             * Get a CollectionReader from a CollectionReader class, a type system, and<a name="line.94"></a>
<FONT color="green">095</FONT>             * a set of configuration parameters.<a name="line.95"></a>
<FONT color="green">096</FONT>             * <a name="line.96"></a>
<FONT color="green">097</FONT>             * @param readerClass<a name="line.97"></a>
<FONT color="green">098</FONT>             *            The class of the CollectionReader to be created.<a name="line.98"></a>
<FONT color="green">099</FONT>             * @param typeSystem<a name="line.99"></a>
<FONT color="green">100</FONT>             *            A description of the types used by the CollectionReader (may<a name="line.100"></a>
<FONT color="green">101</FONT>             *            be null).<a name="line.101"></a>
<FONT color="green">102</FONT>             * @param configurationParameters<a name="line.102"></a>
<FONT color="green">103</FONT>             *            Any additional configuration parameters to be set. These<a name="line.103"></a>
<FONT color="green">104</FONT>             *            should be supplied as (name, value) pairs, so there should<a name="line.104"></a>
<FONT color="green">105</FONT>             *            always be an even number of parameters.<a name="line.105"></a>
<FONT color="green">106</FONT>             * @return The CollectionReader created and initialized with the type system<a name="line.106"></a>
<FONT color="green">107</FONT>             *         and configuration parameters.<a name="line.107"></a>
<FONT color="green">108</FONT>             * @throws ResourceInitializationException<a name="line.108"></a>
<FONT color="green">109</FONT>             */<a name="line.109"></a>
<FONT color="green">110</FONT>            public static CollectionReader createCollectionReader(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.110"></a>
<FONT color="green">111</FONT>                            TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException {<a name="line.111"></a>
<FONT color="green">112</FONT>                    return createCollectionReader(readerClass, typeSystem, (TypePriorities) null, configurationData);<a name="line.112"></a>
<FONT color="green">113</FONT>            }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>            public static CollectionReader createCollectionReader(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.115"></a>
<FONT color="green">116</FONT>                            TypeSystemDescription typeSystem, String[] prioritizedTypeNames, Object... configurationData) throws ResourceInitializationException {<a name="line.116"></a>
<FONT color="green">117</FONT>                    TypePriorities typePriorities = TypePrioritiesFactory.createTypePriorities(prioritizedTypeNames);<a name="line.117"></a>
<FONT color="green">118</FONT>                    return createCollectionReader(readerClass, typeSystem, typePriorities, configurationData);<a name="line.118"></a>
<FONT color="green">119</FONT>    <a name="line.119"></a>
<FONT color="green">120</FONT>            }<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>            public static CollectionReader createCollectionReader(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.122"></a>
<FONT color="green">123</FONT>                            TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException {<a name="line.123"></a>
<FONT color="green">124</FONT>                    CollectionReaderDescription desc = createDescription(readerClass, typeSystem, typePriorities, configurationData);<a name="line.124"></a>
<FONT color="green">125</FONT>                    return createCollectionReader(desc);<a name="line.125"></a>
<FONT color="green">126</FONT>            }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>            <a name="line.128"></a>
<FONT color="green">129</FONT>            public static CollectionReader createCollectionReader(CollectionReaderDescription desc) throws ResourceInitializationException {<a name="line.129"></a>
<FONT color="green">130</FONT>                    // create the CollectionReader<a name="line.130"></a>
<FONT color="green">131</FONT>                    CollectionReader reader;<a name="line.131"></a>
<FONT color="green">132</FONT>                    try {<a name="line.132"></a>
<FONT color="green">133</FONT>                            reader = (CollectionReader)  (Class.forName(desc.getImplementationName()).newInstance());<a name="line.133"></a>
<FONT color="green">134</FONT>                    }<a name="line.134"></a>
<FONT color="green">135</FONT>                    catch (Exception e) {<a name="line.135"></a>
<FONT color="green">136</FONT>                            throw new ResourceInitializationException(e);<a name="line.136"></a>
<FONT color="green">137</FONT>                    }<a name="line.137"></a>
<FONT color="green">138</FONT>                    reader.initialize(desc, null);<a name="line.138"></a>
<FONT color="green">139</FONT>                    return reader;<a name="line.139"></a>
<FONT color="green">140</FONT>            }<a name="line.140"></a>
<FONT color="green">141</FONT>    <a name="line.141"></a>
<FONT color="green">142</FONT>            <a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>            public static CollectionReaderDescription createDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.144"></a>
<FONT color="green">145</FONT>                            TypeSystemDescription typeSystem, Object... configurationData) throws ResourceInitializationException {<a name="line.145"></a>
<FONT color="green">146</FONT>                     return createDescription(readerClass, typeSystem, (TypePriorities)null, configurationData);<a name="line.146"></a>
<FONT color="green">147</FONT>            }<a name="line.147"></a>
<FONT color="green">148</FONT>    <a name="line.148"></a>
<FONT color="green">149</FONT>            public static CollectionReaderDescription createDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.149"></a>
<FONT color="green">150</FONT>                            TypeSystemDescription typeSystem, String[] prioritizedTypeNames, Object... configurationData) throws ResourceInitializationException {<a name="line.150"></a>
<FONT color="green">151</FONT>                    TypePriorities typePriorities = TypePrioritiesFactory.createTypePriorities(prioritizedTypeNames);<a name="line.151"></a>
<FONT color="green">152</FONT>                    return createDescription(readerClass, typeSystem, typePriorities, configurationData);<a name="line.152"></a>
<FONT color="green">153</FONT>    <a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>    <a name="line.155"></a>
<FONT color="green">156</FONT>            <a name="line.156"></a>
<FONT color="green">157</FONT>            public static CollectionReaderDescription createDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.157"></a>
<FONT color="green">158</FONT>                            TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... configurationData) throws ResourceInitializationException {<a name="line.158"></a>
<FONT color="green">159</FONT>                    return createDescription(readerClass, typeSystem, typePriorities, (Capability[])null, configurationData);<a name="line.159"></a>
<FONT color="green">160</FONT>            }<a name="line.160"></a>
<FONT color="green">161</FONT>    <a name="line.161"></a>
<FONT color="green">162</FONT>            <a name="line.162"></a>
<FONT color="green">163</FONT>            public static CollectionReaderDescription createDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.163"></a>
<FONT color="green">164</FONT>                            TypeSystemDescription typeSystem, TypePriorities typePriorities, Capability[] capabilities, Object... configurationData) throws ResourceInitializationException {<a name="line.164"></a>
<FONT color="green">165</FONT>                    ConfigurationData cdata = ConfigurationParameterFactory.createConfigurationData(configurationData);<a name="line.165"></a>
<FONT color="green">166</FONT>                    return createDescription(readerClass, typeSystem, typePriorities, capabilities, cdata.configurationParameters, cdata.configurationValues);<a name="line.166"></a>
<FONT color="green">167</FONT>            }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>            <a name="line.169"></a>
<FONT color="green">170</FONT>            public static CollectionReaderDescription createDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.170"></a>
<FONT color="green">171</FONT>                            TypeSystemDescription typeSystem, TypePriorities typePriorities, Capability[] capabilities, ConfigurationParameter[] configurationParameters, Object[] configurationValues) throws ResourceInitializationException {<a name="line.171"></a>
<FONT color="green">172</FONT>                    // create the descriptor and set configuration parameters<a name="line.172"></a>
<FONT color="green">173</FONT>                    CollectionReaderDescription desc = new CollectionReaderDescription_impl();<a name="line.173"></a>
<FONT color="green">174</FONT>                    desc.setFrameworkImplementation(Constants.JAVA_FRAMEWORK_NAME);<a name="line.174"></a>
<FONT color="green">175</FONT>                    desc.setImplementationName(readerClass.getName());<a name="line.175"></a>
<FONT color="green">176</FONT>                    <a name="line.176"></a>
<FONT color="green">177</FONT>                    if(configurationParameters != null)<a name="line.177"></a>
<FONT color="green">178</FONT>                            ResourceCreationSpecifierFactory.setConfigurationParameters(desc, configurationParameters, configurationValues);<a name="line.178"></a>
<FONT color="green">179</FONT>    <a name="line.179"></a>
<FONT color="green">180</FONT>                    // set the type system<a name="line.180"></a>
<FONT color="green">181</FONT>                    if (typeSystem != null) {<a name="line.181"></a>
<FONT color="green">182</FONT>                            desc.getCollectionReaderMetaData().setTypeSystem(typeSystem);<a name="line.182"></a>
<FONT color="green">183</FONT>                    }<a name="line.183"></a>
<FONT color="green">184</FONT>                    <a name="line.184"></a>
<FONT color="green">185</FONT>                    if(typePriorities != null)<a name="line.185"></a>
<FONT color="green">186</FONT>                            desc.getCollectionReaderMetaData().setTypePriorities(typePriorities);<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>                    if(capabilities != null)<a name="line.188"></a>
<FONT color="green">189</FONT>                            desc.getCollectionReaderMetaData().setCapabilities(capabilities);<a name="line.189"></a>
<FONT color="green">190</FONT>                    <a name="line.190"></a>
<FONT color="green">191</FONT>                    return desc;<a name="line.191"></a>
<FONT color="green">192</FONT>            }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>            public static CollectionReaderDescription reflectDescription(Class&lt;? extends CollectionReader&gt; readerClass,<a name="line.194"></a>
<FONT color="green">195</FONT>                            TypeSystemDescription typeSystem, TypePriorities typePriorities, Object... cData) throws ResourceInitializationException {<a name="line.195"></a>
<FONT color="green">196</FONT>                    <a name="line.196"></a>
<FONT color="green">197</FONT>                    ConfigurationData configurationData = ConfigurationParameterFactory.createConfigurationData(readerClass);<a name="line.197"></a>
<FONT color="green">198</FONT>                    Capability[] capabilities = CapabilityFactory.createCapability(readerClass);<a name="line.198"></a>
<FONT color="green">199</FONT>                    CollectionReaderDescription aed = createDescription(readerClass, typeSystem, typePriorities, capabilities, configurationData.configurationParameters, configurationData.configurationValues);<a name="line.199"></a>
<FONT color="green">200</FONT>                    setConfigurationParameters(aed, cData);<a name="line.200"></a>
<FONT color="green">201</FONT>                    return aed;<a name="line.201"></a>
<FONT color="green">202</FONT>            }<a name="line.202"></a>
<FONT color="green">203</FONT>    <a name="line.203"></a>
<FONT color="green">204</FONT>            public static void setConfigurationParameters(CollectionReaderDescription collectionReaderDescription, Object... configurationData) throws ResourceInitializationException {<a name="line.204"></a>
<FONT color="green">205</FONT>                    ConfigurationData cdata = ConfigurationParameterFactory.createConfigurationData(configurationData);<a name="line.205"></a>
<FONT color="green">206</FONT>                    ResourceCreationSpecifierFactory.setConfigurationParameters(collectionReaderDescription, cdata.configurationParameters, cdata.configurationValues);<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>            <a name="line.209"></a>
<FONT color="green">210</FONT>    }<a name="line.210"></a>




























































</PRE>
</BODY>
</HTML>
